howdy! this folder contains a bunch of assets you can use to create a custom lover for Wife's Bedroom!

as of Wife's Bedroom v1.2, there are 3 different types of custom assets you can create:

- custom lovers (aka custom tops, the one doing the penetrating)
- custom partners (aka custom bottoms, the one being penetrated)
- custom bedrooms (aka custom backgrounds)

alongside this readme file there are two folders, one contains templates you can use and one contains examples that I have created featuring my characters as well as a few others, you're welcome to play around with those to get a general idea of how the custom assets work

------------------------

[HOW TO ADD CUSTOM ASSETS]

there are two methods to adding custom assets to the game: you may either place the folder containing the sprites and the custom_data file (.futa, .spouse, or .bedroom) directly next to the .exe, or you may create a new folder named "custom" (all lowercase) and place them in there, you do not need to create separate folders for the different types of assets since the game sorts them automatically

folder structure example:
- WB folder
- - wifes_bedroom.exe
- - custom lover 1 folder
- - - custom_data.futa + assets
- - custom lover 2 folder
- - - custom_data.futa + assets

OR

- WB folder
- - wifes_bedroom.exe
- - custom
- - - custom lover 1 folder
- - - - custom_data.futa + assets
- - - custom lover 2 folder
- - - - custom_data.futa + assets

to know if the game detected custom assets, a small text will display underneath the version number on the top left saying "custom assets loaded" alongside the number of each asset type detected, the game will also inform you if certain folders are missing required assets

general notes:
- sprites for custom lovers & partners can be as big or small as you want, as long as they have the same number of frames (see Tiffany as an example)
- you can adjust the x & y origins for sprites and portraits in case you want to adjust the size or the sprites are off center
- each asset has a name, desc, and author section in their custom data files, feel free to fill that out in case you want to share it with other people
- if a folder is missing an asset it will still be detected by the game but missing assets will be replaced by the default, make sure that the files have the exact same names and file types if not loading correctly
- you can remove any of the values in the custom data files if you'd like to, if you add more just make sure they have the correct names and are under the correct tags otherwise it won't load correctly (i.e. name & desc should be under [info] and not [sprite])

------------------------

[CUSTOM LOVERS]

custom lover folders should contain:
- custom_portrait.png [10 frames]
- custom_mating_press.png [9 frames]
- custom_reverse_cowgirl.png [5 frames, but will still detect the sprite if it has 7 frames from v1.1]
- custom_condom.png [2 frames]
- custom_xray.png [3 frames]
- custom_data.futa

optional files:
- custom_condom_broken.png [2 frames]
- custom_xray_broken.png [1 frame]

customization options:
- max orgasms & pumps per orgasm
- default moaning sounds (0 = disabled, 1 = enabled)
- heavy breasts for hyper characters (see Tiffany as an example)
- stomach bulge width & height multipliers in case you make the penis bigger than the default
- cum color (created using an RGB value from cum_r, cum_g, and cum_b)
- condom color, only applies to packets and balloons in case your custom condom color isn't pure white

custom lovers also have custom moaning/orgasm audio support, in the custom lover folder you can create 3 additional folders:
- moan_slow
- moan_fast
- orgasm

the game will replace the default moaning sounds with the contents of these folders, the files must have the .ogg file format (.mp3, .wav, or others will not work) and you can put in as many as you'd like

------------------------

[CUSTOM PARTNERS]

custom partner folders should contain:
- custom_portrait.png [10 frames]
- custom_mating_press.png [4 frames]
- custom_reverse_cowgirl.png [5 frames]
- custom_xray.png [4 frames]
- custom_data.spouse

customization options:
- fertile (0 = false, 1 = true, false disables pregnancy & womb xray)
- custom egg color (using egg_r, egg_g, and egg_b)

------------------------

[CUSTOM DIALOGUE]

both lovers and partners support custom dialogue, there are two methods to implement it:
- through the custom_data files
  - the template custom lover has examples for all of the available dialogue triggers, you can add more by increasing the number next to it (i.e. spank_0, spank_1, and spank_2 for 3 separate spank responses), make sure it starts with 0

- with .json files
  - just drop dialogue.json into the custom character's folder, template in templates folder

either method works, the custom_data method will probably be less of a hassle but if you go the .json route please make sure everything is properly formatted otherwise the game WILL crash
if you need help with formatting/repairing .json files, you can check out https://jsonlint.com/json-repair

------------------------

[CUSTOM COUPLES]

you are able to load in both a custom lover and partner simultaneously by placing both of the character's assets in the same folder as a custom lover and by add a "_alt" to the custom partner's sprites (i.e. the top will be custom_mating_press.png and the bottom will be custom_mating_press_alt.png)

custom couples only need the custom_data.futa file and don't need a .spouse file, the partner's data is stored in the .futa file (see Carissa & Aqua in the examples folder as an example)

if you're using .json file dialogue, you can also use an additional file called dialogue_alt.json for partners

------------------------

[CUSTOM BEDROOMS]

custom bedroom folders should contain:
- background.png [4 frames]
- custom_data.bedroom
- thumbnail.png

optional files:
- background_animated.png [as many frames as you want]
- music.ogg

customization options (under [background]):
- foreground_breathe, it gives the layer right behind the bed a slight swaying effect (see terato background as an example)
- foreground_front, draws the layer right behind the bed in front of it
- audio_effect (0 = none, 1 = reverb, 2 = muffled)
- condom_strip, toggles condom strip visibility
- animation_speed, changes how fast the animated background plays

note: animated background sprite sheets can be as big as you want as long as each frame is 440x256, just keep in mind that bigger file sizes will take longer to load in

------------------------

that's all you really need to know for creating your own custom characters and scenes for wife's bedroom, if you need a pixel art software i would recommend aseprite or libresprite, but any art program that can make pixel art with transparency will work just fine! if you're an aseprite user I've also included some .aseprite files in the templates, so hopefully those will be of use

if you have any issues with the custom assets or have any questions about making/adding them in, you're welcome to DM me on discord (@aplove) and i'll try to help out if i can, if you're playing a modded version i unfortunately can't help you but can direct you to people who can

thank you for playing wife's bedroom! enjoy!